home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / renegade / rene0405.zip / RENEMAIL.DOC < prev    next >
Text File  |  1996-04-04  |  14KB  |  284 lines
  1.  
  2.  
  3.                                R E N E M A I L
  4.                                ~~~~~~~~~~~~~~~
  5.  
  6.                Renegade Fidonet Compatible Network Mail Interface
  7.  
  8.                               Operations Manual
  9.  
  10.                                 Version 1.00
  11.  
  12.                      Copyright (C) 1991-1996 by Cott Lang
  13.                              All Rights Reserved.
  14.  
  15.  
  16.  
  17.  
  18.                                  INTRODUCTION
  19.          _________________________________________________________________
  20.  
  21.              This documentation assumes that you have a working knowledge of
  22.         Fidonet  echomail  processing.  It  is  beyond  the  scope  of  this
  23.         documentation  to  explain  the  concepts  of  networking  and  mail
  24.         processing.  You should  refer to  your echomail processing system's
  25.         documentation for more information.
  26.  
  27.              Renemail  is  an  interface  program  that allows  Renegade  to
  28.         support  Echomail  from  any  network  supporting Fidonet standards.
  29.         Renemail  is  a  very  simplistic  program  at  this  point  in  its
  30.         development.  It has only three major functions:
  31.  
  32.  
  33.           o    Scanning - Renemail will  scan  Renegade's  Echomail  message
  34.                bases  and process outbound messages, translating  them  into
  35.                Fidonet compatible *.MSG  files for  further processing by an
  36.                echomail processing system and your front-end mailer.
  37.  
  38.           o    Tossing  - Renemail   will   import  *.MSG   format  messages
  39.                prepared  by  your  front-end  mailer and echomail processing
  40.                system into the appropriate Renegade message bases.
  41.  
  42.           o    Purging  - Renemail will optionally purge  imported or tossed
  43.                messages from your echomail directories.
  44.  
  45.  
  46.           o    Netmail  - Renemail will import and export netmail to and
  47.                from your Email system.
  48.  
  49.  
  50.              Renemail does  not have its own configuration.  Renemail relies
  51.         completely  on your  Renegade Bulletin  Board System's configuration
  52.         for all necessary information.
  53.  
  54.  
  55.                                     REQUIREMENTS
  56.          _________________________________________________________________
  57.  
  58.  
  59.              Renemail is  not a  stand-alone  package.  You  will  need  the
  60.         following additional programs:
  61.  
  62.           o    The Renegade Bulletin Board System version 1.0
  63.  
  64.           o    A front-end mailer.  Front end  mailers  are  responsible for
  65.                answering incoming calls, and the  transmission and reception
  66.                of outbound and inbound mail and files. Some available front-
  67.                end mailers are:
  68.  
  69.                  o Frontdoor    o BinkleyTerm   o SeaDog   o D'Bridge
  70.  
  71.           o    An echomail processing system. The echomail processing system
  72.                is responsible for processing  inbound and  outbound mail for
  73.                Renemail  and  the front-end  mailer to work  together.  Some
  74.                commonly used echomail processing systems are:
  75.  
  76.                  o Confmail  o Vpurge  o Qmail  o SquishMail  o TosScan
  77.  
  78.           o    A  groupmail  processing  system  is   necessary  if  you are
  79.                interested in  implementing groupmail  with Renegade.  Two of
  80.                the more common systems are:
  81.  
  82.                                o Group         o Gmail
  83.  
  84.  
  85.  
  86.                                   INSTALLATION
  87.          _________________________________________________________________
  88.  
  89.  
  90.              If you have not already, decompress the  Renemail  distribution
  91.         archive onto your  hard drive.  RENEMAIL.EXE  is the  only  required
  92.         program in the archive.It can be placed anywhere on your hard drive,
  93.         and run from anywhere  on your system.  It  is, however, recommended
  94.         that you place it in your main Renegade directory.
  95.  
  96.              When Renemail runs, it needs to be able to locate your system's
  97.         RENEGADE.DAT file. Renemail will first search the current directory,
  98.         then it will search your path.   If  you are  not  running  Renemail
  99.         from your main Renegade directory, then make sure your main Renegade
  100.         directory is part of your path.  It is strongly recommended that you
  101.         run Renemail from your  main directory  and that you  NOT  have your
  102.         Renegade main directory in your path statement for security reasons.
  103.  
  104.  
  105.                                    OPERATION
  106.          _________________________________________________________________
  107.  
  108.             Renemail has  only three  major  command  line options. They are
  109.         mutually exclusive.  Renemail will  only perform the  first function
  110.         specified on the command line, regardless of what it is  or how many
  111.         other functions are specified.
  112.  
  113.               Syntax:
  114.  
  115.                          RENEMAIL [FUNCTION]
  116.  
  117.           Where [FUNCTION] is one of the following:
  118.  
  119.              -S   -  Scan messages.  As explained previously, this scans new
  120.                      messages in Renegade echomail  bases and  prepares them
  121.                      for outbound  processing  by  your  echo  or  groupmail
  122.                      processor.  Do this before  any outbound echo/groupmail
  123.                      processing.
  124.  
  125.              -T   -  Toss  messages.  Also  as  previously  explained,  this
  126.                      tosses  inbound  echo  or  groupmail  messages into the
  127.                      appropriate Renegade message  bases.  Do this after any
  128.                      inbound echo/groupmail processing.
  129.  
  130.              -P   -  Purge messages.  This  function  deletes all  the *.MSG
  131.                      files in all of your echomail directories.  This should
  132.                      be used  with care as  not to delete  outbound messages
  133.                      that  have  not  yet  been processed  by your  echomail
  134.                      processor, or  inbound messages  that have not yet been
  135.                      tossed by Renemail into Renegade message bases.  If you
  136.                      are having problems with Renemail  NOT deleting all  of
  137.                      the *.MSG  files, use  -P -F  which  specifies Renemail
  138.                      should NOT use the fast method of purging.
  139.  
  140.  
  141.              Renemail has four  additional command line options which are
  142.          not mutually exclusive:
  143.  
  144.              -A   -  Absolute scan.  Normally, Renemail  scans  only message
  145.                      bases with new outbound messages.  This  flag indicates
  146.                      that Renemail should scan all echomail bases.
  147.  
  148. *            -F   -  Do not use the fast purge option.  On some systems, the
  149.                      normal fast purge does not work corectly.  If the purge
  150.                      option does  not appear  to be deleting the *.MSG files
  151.                      in your echomail directories, use this option.
  152.  
  153.              -N   -  No netmail.  This  indicates to  Renemail that  netmail
  154.                      should  not  be  scanned, tossed, or  purged during the
  155.                      current mail processing session.
  156.  
  157.              -D   -  Do not delete netmail. This is used in conjunction with
  158.                      the -T (Toss) command, and forces  Renemail  to  update
  159.                      the  status bits  of imported  netmail messages  rather
  160.                      than deleting them after being tossed.
  161.  
  162. *            -B   -  Use BIOS video output.  This is self explanitory.
  163.  
  164.  
  165.              -O   -  Only scan/toss the Netmail base
  166.  
  167.              -I   -  Do NOT ignore 1.MSG.  Most mail processors use 1.MSG to
  168.                      store data  for  mail processing. Some don't. If  yours
  169.                      does NOT, and you want  to import 1.MSG, then  use this
  170.                      option.
  171.  
  172.  
  173.  
  174.                                  USING THE SYSTEM
  175.          _________________________________________________________________
  176.  
  177.  
  178.              As stated before, Renemail has been created to  work with other
  179.         programs to operate correctly.   Renemail  only  translates  between
  180.         Renegade and the echo or groupmail processor of your choice. Because
  181.         of this, you are  responsible for executing the previously mentioned
  182.         processing system(s) in relation to Renemail.
  183.  
  184.              About the only  efficient way to perform these  tasks is to use
  185.         batch files. It is recommended that you use one batch file that runs
  186.         your front-end mailer, Renegade, Renemail, and anything else used in
  187.         your BBS's daily routine.  This batch file should be written in such
  188.         a way  that whenever  inbound mail is received, the front-end mailer
  189.         exits and the  echomail processor and Renemail are both executed, in
  190.         that order.  When Renegade signals via  ERRORLEVEL  that new echo or
  191.         groupmail has been  entered in the  message bases, Renemail  and the
  192.         echomail processor should again be run, in that order.
  193.  
  194.              Here is an example of what  should take  place when an incoming
  195.         echomail packet is received.  This  example uses Confmail because it
  196.         is the simplest echomail processor available.   The example  assumes
  197.         your main Renegade directory is C:\RENEGADE,and that you are running
  198.         both programs from there. It also assumes you will be using PKWare's
  199.         PKUNPAK to unarc incoming Arcmail packets.
  200.  
  201.  
  202.              CD C:\RENEGADE                   {Change to the main directory   }
  203.              CONFMAIL IMPORT -A PKUNPAK       {Execute echomail processor     }
  204.              RENEMAIL -T                      {Invoke Renemail's TOSS function}
  205.              RENEMAIL -P                      {Optionally PURGE echomail dirs }
  206.  
  207.  
  208.              Equally simplistic is the following example of  what your batch
  209.         file should  do when  it is  detected that new echo or groupmail has
  210.         been entered in  Renegade, or whenever  you want to process new out-
  211.         bound mail.  Please note that  the order in which these two programs
  212.         are executed is crucial to correct operation.
  213.  
  214.  
  215.              CD C:\RENEGADE                   {Change to the main directory   }
  216.              RENEMAIL -S                      {Invoke Renemail's SCAN function}
  217.              CONFMAIL EXPORT                  {Execute echomail processor     }
  218.              RENEMAIL -P                      {Optionally PURGE echomail dirs }
  219.  
  220.  
  221.              The RENEMAIL -P (or PURGE) function is optional,but recommended
  222.         mainly to save disk space.  It will not  affect mail  processing, as
  223.         Renemail  and  your  echomail processing system will not process the
  224.         messages twice.  The above  example for exporting mail does not have
  225.         Confmail arcing outgoing packets.  This  can  be added  easily using
  226.         Confmail's  -A and -D  commands.  Using  Arcmail  is recommended for
  227.         shorter  mail  transmission times.  If  you  have  trouble  with the
  228.         purging function, try:
  229.  
  230.               RENEMAIL -P -F
  231.  
  232.              We recommend that the first echo you  attempt to pick up is the
  233.         National Renegade Echo.  The author  of this  program is in there to
  234.         answer your questions and hear your comments!
  235.  
  236.  
  237.  
  238.  
  239.                            SHAREWARE LICENSE AGREEMENT
  240.          _________________________________________________________________
  241.  
  242.  
  243.         This  software  and documentation is protected by both United States
  244.         copyright law and international treaty provisions. Users are granted
  245.         a  limited  license to make and use  a copy of  Renemail  for  their
  246.         Renegade Bulletin Board System.
  247.  
  248.         You are free to make  copies  of  the  software  and  documentation,
  249.         however, all materials relating to this license statement, software,
  250.         documentation,    order   information,   copyright   and   trademark
  251.         statements  must remain intact as supplied in the original shareware
  252.         package.  You  may  not  distribute,  rent, sublicense, integrate or
  253.         lease  the software or the documentation. You may not alter, modify,
  254.         or  adapt  the  software or documentation, including but not limited
  255.         to   translating,   decompiling,  reverse  assembling,  or  creating
  256.         derivative  works.
  257.  
  258.         The author  disclaims all   warranties, either   express or implied,
  259.         including but  not limited to implied warranties of  merchantability
  260.         and fitness  for a particular purpose, with  respect to the software
  261.         and any accompanying written materials. In no event shall the author
  262.         be liable for any damages whatsoever (including, without limitation,
  263.         damages for loss of business profits, business interruption, loss of
  264.         business information, or  other pecuniary  loss) arising  out of the
  265.         use of  this  product,  even if  the author  has been advised of the
  266.         possibility of  such damges.  Because some  states do  not allow the
  267.         exclusion or limitation of liability for consequential or incidental
  268.         damages, the above limitations may not apply to you.
  269.  
  270.  
  271.  
  272.                                   CREDITS
  273.          _________________________________________________________________
  274.  
  275.  
  276.              All  brand  and product names referenced in this  document  are
  277.         trademarks,  registered trademarks, or  copyrighted  works  of their
  278.         respective holders.
  279.  
  280.              Special thanks to all the beta sites throughout the  world that
  281.         helped get Renemail through early beta stages!
  282.  
  283.  
  284.